bitkeeper revision 1.1159.217.18 (41ea5633KLfjrmzpi1tzeYsbJqWJOw)
authoriap10@labyrinth.cl.cam.ac.uk <iap10@labyrinth.cl.cam.ac.uk>
Sun, 16 Jan 2005 11:55:31 +0000 (11:55 +0000)
committeriap10@labyrinth.cl.cam.ac.uk <iap10@labyrinth.cl.cam.ac.uk>
Sun, 16 Jan 2005 11:55:31 +0000 (11:55 +0000)
Merge labyrinth.cl.cam.ac.uk:/auto/groups/xeno-xenod/BK/xen-2.0-testing.bk
into labyrinth.cl.cam.ac.uk:/auto/anfs/scratch/labyrinth/iap10/xeno-clone/xen-unstable.bk

1  2 
tools/libxc/xc.h

index f8276297a12d7628fd9656fd227c8b58eef83205,c4440d9838f3bc68717ede961f84917524605174..ab1a607b54b83e7211376a8ea57f3a80fb7bcff6
@@@ -24,11 -23,42 +24,41 @@@ typedef int64_t            s64
  #include <xen/dom0_ops.h>
  #include <xen/event_channel.h>
  #include <xen/sched_ctl.h>
 -#include <xen/io/domain_controller.h>
  
- /* Obtain or relinquish a handle on the 'xc' library. */
+ /*\
+  *  INITIALIZATION FUNCTIONS
+ \*/ 
+ /**
+  * This function opens a handle to the hypervisor interface.  This function can
+  * be called multiple times within a single process.  Multiple processes can
+  * have an open hypervisor interface at the same time.
+  *
+  * Each call to this function should have a corresponding call to
+  * xc_interface_close().
+  *
+  * This function can fail if the caller does not have superuser permission or
+  * if a Xen-enabled kernel is not currently running.
+  *
+  * @return a handle to the hypervisor interface or -1 on failure
+  */
  int xc_interface_open(void);
+ /**
+  * This function closes an open hypervisor interface.
+  *
+  * This function can fail if the handle does not represent an open interface or
+  * if there were problems closing the interface.
+  *
+  * @parm xc_handle a handle to an open hypervisor interface
+  * @return 0 on success, -1 otherwise.
+  */
  int xc_interface_close(int xc_handle);
  
+ /*\
+  * DOMAIN MANAGEMENT FUNCTIONS
+ \*/
  typedef struct {
      u32           domid;
      unsigned int  cpu;
@@@ -60,9 -128,20 +128,21 @@@ int xc_domain_getinfo(int xc_handle
                        u32 first_domid, 
                        unsigned int max_doms,
                        xc_dominfo_t *info);
+ /**
+  * This function returns information about one domain.  This information is
+  * more detailed than the information from xc_domain_getinfo().
+  *
+  * @parm xc_handle a handle to an open hypervisor interface
+  * @parm domid the domain to get information from
+  * @parm info a pointer to an xc_domaininfo_t to store the domain information
+  * @parm ctxt a pointer to a structure to store the execution context of the
+  *            domain
+  * @return 0 on success, -1 on failure
+  */
  int xc_domain_getfullinfo(int xc_handle,
                            u32 domid,
 +                          u32 vcpu,
                            xc_domaininfo_t *info,
                            full_execution_context_t *ctxt);
  int xc_domain_setcpuweight(int xc_handle,